Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What we need to get PDF doc to build... #876

Merged
merged 7 commits into from
Jul 11, 2023
Merged

What we need to get PDF doc to build... #876

merged 7 commits into from
Jul 11, 2023

Conversation

rocky
Copy link
Member

@rocky rocky commented Jul 10, 2023

In the last release, it was difficult enough to get things to build. Going over documentation suffered a little.
I am now starting to do this as part of releasing new docker images. (The last one was 4 months ago)

  • Some references corrected.
  • Remove duplicate sections (in both test and doc) in guide sections
  • Fix a small markup typo in ComplexExpand formatting
  • Summary text now appears in non-guide Chapters which have sections...
  • Also start to go over are regularize summary text.
  • Remove unused Builtin field "abstract".

* Some references corrected.
* Remove duplicate sections (in both test and doc) in guide sections
* Fix a small markup typo in ComplexExpand formatting
@rocky rocky requested a review from mmatera July 10, 2023 14:18
Both are pretty short and it makes the overall organization more
coherent. (Should both code grow a lot, we can create a directory to
make this a "Guide Section".
Also start regularizing section summary text here.
remove Builtin object field "abstract" which is not used.
@@ -987,7 +986,7 @@ class DateStringFormat(Predefined):

<dl>
<dt>'$DateStringFormat'
<dd>gives the format used for dates generated by 'DateString'.
<dd>get the format used for dates generated by 'DateString'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had the feeling that in the docstring we used the style "[Expression] does/returns/gives ..." using a third person in the simple present tense, while the summary_text was in the imperative form, wasn't it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should have just been on the summary text. I'll change this.

In the summary text it is 3rd person active. "get" or "give" would work but for summary text "get" seems to be what is used most.

(But in summary_text it is "get").
Copy link
Contributor

@mmatera mmatera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rocky
Copy link
Member Author

rocky commented Jul 11, 2023

Should commit before I start adding more (of which I am sure there is a lot more to do).

@rocky rocky merged commit 10788e1 into master Jul 11, 2023
@rocky rocky deleted the doc-fixes branch July 11, 2023 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants